home *** CD-ROM | disk | FTP | other *** search
/ Macwelt 1 / Macwelt DVD 1.toast / Web-Publishing / HTML-Editoren / Alpha ƒ / Help / Electric Corrections Help < prev    next >
Encoding:
Text File  |  2000-11-29  |  7.1 KB  |  219 lines
  1.  
  2. Electric Corrections Help
  3.  
  4.  
  5.                                           help version: 0.3.2
  6.                                                created: 10/05/00 {08:43:42 pm}
  7.                                            last update: 11/29/00 {10:40:28 am}
  8.  
  9.  
  10. This extension package for Alpha helps check for and correct spelling
  11. mistakes or typos as you type.  This is not a spell-checking extension --
  12. instead it is more of a "misspell-checker": you must teach Alpha the common
  13. misspellings or typos to correct using the menu items described below.
  14.  
  15. Whenever you press the return or space key, Alpha will then compare the
  16. previous word to the list of all typos, and correct it if necessary.  This
  17. package also includes a "Smart i" preference, which can automatically
  18. change "i" to "I" as you type.
  19.  
  20. Activating the extension will create four new preferences and insert a new
  21. "Config --> Packages --> Electric Corrections" submenu described below.
  22.     
  23.  
  24.           Preferences
  25.  
  26.  
  27. These preferences appear in the "Config --> Preferences --> Electrics"
  28. menu.  They can also be changed via the "Electric Corrections" menu.
  29.  
  30.     Smart i
  31.  
  32. Automatically convert " i " to " I ".  
  33.  
  34.     Smart i Modes
  35.  
  36. Allows you to specify the modes that use the "Smart i" feature, initially
  37. including only "Text TeX Bib HTML".  If this list is empty, automatic
  38. correction applies to all modes.
  39.  
  40.     Turn Corrections On/Off
  41.  
  42. Turns automatic corrections of typos on or off.  This does not affect the
  43. "Smart i" preference.
  44.  
  45.     Correcting Modes
  46.  
  47. Allows you to specify the modes that check for misspellings.  If this list
  48. is empty (the default value), automatic correction applies to all modes.
  49.  
  50.  
  51.           Electric Corrections Menu
  52.  
  53.  
  54.     View Corrections
  55.  
  56. Open a window with all current typos.  The package only supplies one typo
  57. to initially correct, changing "hte" to "the"
  58.  
  59.     Add Corrections
  60.  
  61. Open a dialog to create new typos.  Only lower-case typos need to be
  62. entered -- both lower-case and capitalized typos will be corrected
  63. automatically.
  64.  
  65.     Edit Corrections
  66.  
  67. Open a list-pick dialog to edit all typos.
  68.  
  69.     Remove Corrections
  70.  
  71. Open a list-pick dialog to remove all user-defined typos.
  72.  
  73.     Smart i
  74.  
  75. Automatically convert " i " to " I ".  
  76.  
  77. (This is a toggleable menu item, turning the preference on and off.)
  78.  
  79.     Smart i Modes
  80.  
  81. Allows you to specify the modes that use the "Smart i" preference,
  82. initially including only "Text TeX Bib HTML".  If this list is empty,
  83. automatic correction applies to all modes.
  84.  
  85.     Turn Corrections On/Off
  86.  
  87. Turns automatic corrections of misspellings or typos on or off.  This does
  88. not affect the "Smart i" preference.
  89.  
  90.     Correcting Modes
  91.  
  92. Allows you to specify the modes that check for typos.  If this list is
  93. empty (the default value), automatic correction applies to all modes.
  94.  
  95.     Corrections Help
  96.  
  97. Open this file.
  98.     
  99.  
  100.           Usage
  101.  
  102.  
  103. Following every <space> or <return> keystroke, the preceding word is
  104. checked against the list of defined typos -- if the word matches, it is
  105. deleted and the correction is inserted.  If the "Smart i" preference is
  106. set, then any lone i will be converted to I. Preceding words are checked
  107. even if followed by an intermediate character such as , .  ; etc.  -- the
  108. correction is inserted without disturbing the following characters.  So
  109.  
  110.     Where was i?
  111.     i decided to ask hte, well, obviously oblivious inn-keeper, ...   
  112.  
  113. corrects to 
  114.  
  115.     Where was I?
  116.     I decided to ask the, well, obviously oblivious inn-keeper, ...   
  117.  
  118. All user-defined misspellings/typos are automatically converted to both
  119. lower case and capitalized words -- both "hte --> the" and "Hte --> The"
  120. work, but only the first must be defined.  Note that if you have multiple
  121. misspellings for the same word, you must defined each one separately, such
  122. as "teh --> the".  All typos will be corrected in any mode listed in the
  123. "Correcting Modes" preference -- it is not possible (at least not yet ...) 
  124. to define mode-specific typos.
  125.     
  126.  
  127. Here's one way to exploit this feature: I have defined the following
  128. "typos", which I generally will not accidentally type:
  129.  
  130.     "sgy  --> sociology"
  131.     "scal --> sociological"
  132.     "slly --> sociologically"
  133.     "sc   --> social capital"
  134.  
  135. Now whenever I type "sgy" or "Sgy", the "correction" is automatically
  136. inserted if I follow it with a <space> or <return>.  Suppose that I have
  137. the terms "screaming" and "somethingCruddy" in my file, and I have just
  138. typed "sc".  Note the following electric options:
  139.  
  140.     <space> or <return>:    correct to      "social capital"
  141.     <completion key>:       complete to     "screaming"
  142.     <expansion key>:        expand to       "somethingCruddy"
  143.  
  144.  
  145. If you would like to define "electric corrections over-ride" keys, open a 
  146. "prefs.tcl" file and add these lines:
  147.  
  148.     Bind '\ ' <s> {insertText "\ "}
  149.     Bind '\r' <s> {bind::CarriageReturn}
  150.  
  151. Holding down the shift key while pressing <space> or <return> will then
  152. over-ride corrections and simply enter a space or a carriage return.
  153.  
  154.  
  155.           Possible future directions
  156.     
  157.  
  158.   • Include a pre-defined set of typos that has something more than simply
  159.     "hte".  I would just as soon leave it up to the user to create them,
  160.     but if somebody has a list that they would like to send along (with
  161.     common typos and the corrections, please) I'll include it in future
  162.     versions.  One concern that I have is that for such a list to be truly
  163.     useful, it should be comprehensive, and that will both make it much
  164.     more difficult for the user to know what's in there and potentially
  165.     slow down the correcting process.
  166.     
  167.     Procedures have already been written to unset/restore the default 
  168.     list.  It would be possible to come up with several different lists to 
  169.     accommodate different editing settings, or languages ...
  170.     
  171.   • Allow the creation of mode-specific corrections, similarly to
  172.     mode-specific completions.  I don't have any objections, but I'm not
  173.     sure about the best way to accomplish this.
  174.     
  175. Source code can be found in "elecCorrections.tcl" -- contributions are
  176. certainly welcome.
  177.  
  178.  
  179.           Acknowledgments
  180.  
  181.  
  182. This package was inspired by "Electric Completions / Expansions", and based
  183. upon the proc: sql_electUpper found in "sqlMode.tcl" (Joel D. Elkins.) 
  184. Many thanks to Vince Darley and Bernard Desgraupes for several bug fixes
  185. and suggestions.
  186.  
  187.  
  188.           License and Disclaimer
  189.  
  190.  
  191. This library is free software; you can redistribute it and/or modify it
  192. under the terms of the GNU Library General Public License as published by
  193. the Free Software Foundation; either version 2 of the License, or (at your
  194. option) any later version.
  195.  
  196. This library is distributed in the hope that it will be useful, but WITHOUT
  197. ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  198. FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
  199. License for more details.
  200.  
  201. You should have received a copy of the GNU Library General Public License
  202. along with this library; if not, write to the Free Foundation, Inc., 59
  203. Temple Place, Suite 330, Boston, MA 02111-1307 USA
  204.  
  205. This mode is free.  Alpha is shareware ! {{register}}
  206.  
  207.  
  208. cheers,
  209.  
  210. -- Craig
  211.  
  212.  
  213.   Author:  Craig Barton Upright
  214.   E-mail:  <cupright@princeton.edu>
  215.     mail:  Princeton University,  Department of Sociology
  216.            Princeton, New Jersey  08544
  217.      www:  <http://www.princeton.edu/~cupright/>
  218.  
  219.